#!/usr/bin/env python3
# SPDX-License-Identifier: GPL-2.0 or GPL-3.0
# Copyright © 2019 Ariadne Devos
# -*- coding: utf-8 -*-
#
# This tells Sphinx how to process the documentation.

extensions = []
templates_path = []
# reStructuredText is used
source_suffix = '.rst'
# ©, ‘’ and others may be used
source_encoding = 'utf-8-sig'
# This is the main page, which transcludes all other text sources
master_doc = 'index'

# General information about the project.
project = 's²'
html_show_copyright = False
author = "XXX don't emit, change the template"

exclude_patterns = []

# Don't misspell `fputs` as `fputs()` in cross-references.
add_function_parentheses = False
# A style for syntax highlighting. No code is present in the documentation yet,
# though.
pygments_style = 'sphinx'

# This is the default theme of Sphinx and looks nice.
# It even has an internal search function!
html_theme = 'alabaster'

# Images, stylesheets etc.. These override the theme defaults.
html_static_path = ['_static']

# Typographically correct ‘--’ and also tilt straight quotes.
# But don't rely on the latter, write ‘quotes’ instead.
html_use_smartypants = True

# Generate an index of concepts, functions and types.
# TODO: let some things be in the index.
html_use_index = True

# Make a link to the source code of the documents.
#
# Although not terribly useful for text, it gives direct access to copyright
# information. For C source code, however, it directly links the documentation
# to the code. (TODO: extract documentation from C source code.)
html_show_sourcelink = True

html_search_language = 'en'

# Sphinx allows more customisation, which is described in its documentation.

